home *** CD-ROM | disk | FTP | other *** search
/ Front Page News Plus Busi…ctober to 1991 September / Front Page News Plus Business (October 1 1990 - September 30 1991) (Buckmaster) (Wayzata Technology) (1991).iso / mac / _data / twdoc.cdt (.txt) < prev    next >
Encoding:
TextWare CDT File  |  1991-10-09  |  62.8 KB  |  1,284 lines
  1.   
  2.                             TextWare
  3.                         Macintosh Version
  4.                     
  5.  1991 TextWare Corporation
  6. TAG_1.PICT;1
  7. The TextWare logo is a trademark of TextWare Corporation.  The 
  8. other company and product names mentioned are trademarks or 
  9. registered trademarks of the related companies.
  10. You Are Important!
  11. Thank you for choosing TextWare for your full-text indexing and 
  12. retrieval needs.
  13. We at TextWare Corporation value you as a customer and want you to 
  14. be successful using TextWare.
  15. We have tried to provide adequate assistance to ensure your success.  
  16. To take full advantage of the help available to you, please follow 
  17. these two very important guidelines:
  18. Read this manual; it contains the information you need to use 
  19. TextWare.
  20. Use the Help function under the Apple menu and the on-line 
  21. documentation; it will refresh your memory and answer your 
  22. questions while you are using TextWare.
  23. Technical support services are available for all versions, and include 
  24. bug fixes, new releases and unlimited telephone support.  These 
  25. services are free of charge for an initial 90-day period, and 
  26. available for a nominal fee thereafter.
  27. For technical support call (801) 645
  28. 9600 and ask for technical 
  29. support; or you may FAX technical support at (801) 645
  30. 9610.
  31. Contact TextWare Corporation at (801) 645
  32. 9600 or P.O. Box 3267, 
  33. Park City, UT  84060 for more information on the complete TextWare 
  34. product line.
  35. Using TextWare Documentation
  36. This manual describes both TextWare's indexing and retrieval 
  37. capabilities.  Those of you who purchased a retrieve-only license 
  38. will not be able to access and should therefore disregard TextWare's 
  39. indexing capabilities.  
  40. This manual is divided into three principal sections: Installation, 
  41. Getting Started and Reference Guide.
  42. The Installation section provides information about installing 
  43. TextWare on your system.
  44. The Getting Started section introduces TextWare on an elementary 
  45. level.  It gives brief descriptions of some of the TextWare functions 
  46. typically used on a day
  47. to
  48. day basis.
  49. The Reference Guide section contains a list of features and 
  50. functions that will enable the user to find more detailed 
  51. information.
  52. Both the Getting Started and Reference Guide sections use the 
  53. sample databases provided with the package to illustrate how to 
  54. find information easily and quickly.
  55. The TextWare documentation is designed to be helpful to both the 
  56. first
  57. time and experienced user.  The information contained in the 
  58. Getting Started section is geared primarily toward those who are 
  59. feeling their way through TextWare for the first time and are not 
  60. comfortable learning how to use TextWare by experimenting with 
  61. the software.  The Reference Guide section is designed to be helpful 
  62. to the more experienced user who will use TextWare documentation 
  63. when confronted with specific problems.
  64. TextWare is easy to use
  65. most functions can be mastered with only a 
  66. few minutes of instruction.
  67.                             Installation
  68. System Requirements
  69. To run TextWare, you will need a Macintosh Plus or better with 
  70. System Software 6.0.3 or later.  At least 1 megabyte of memory is 
  71. required. 
  72. TextWare will occupy less than 800KB on your hard disk drive.  
  73. However, TextWare requires additional hard disk space to perform 
  74. indexing.
  75. Inventory
  76. Check to be sure that the following items are included in your 
  77. TextWare package:
  78. 1.    Two diskettes labeled "TextWare for Macintosh Version 3.0"
  79. 2.    License Agreement and Registration Card
  80. 3.    The TextWare User Manual (this manual)
  81. Installation Procedure
  82. Insert TextWare Disk #1 into your Macintosh. Drag the TextWare 
  83. folder onto your hard disk. Now insert the second disk.  Drag the two 
  84. folders on the second disk into the TextWare folder.  Be sure to 
  85. install all folders from each diskette.
  86. After you have installed TextWare, please fill in the registration 
  87. card and send it to TextWare Corporation.
  88. Networks
  89. Consult with your network manager, supervisor or administer, 
  90. network documentation and TextWare technical support for 
  91. installation questions.
  92.   
  93.                             Getting Started
  94. 1. Overview
  95. What is TextWare?
  96. The name TextWare encompasses a family of software products for 
  97. full-text indexing and retrieval applications.  This includes 
  98. TextWare, TextWare with Images, retrieve-only versions of both 
  99. products, and the TextWare Toolkit.
  100. TextWare is the leading full-text indexing and retrieval software 
  101. for personal computer (PC), local area network (LAN) and Macintosh 
  102. environments.  With TextWare, each and every word in a free-form, 
  103. unstructured text database can be indexed to create a CardFile, and 
  104. users can instantly retrieve, display and output information.
  105. TextWare with Images enables users to retrieve images and other 
  106. types of data tagged to text to produce a rich multimedia 
  107. environment.  TextWare for the Macintosh always includes 
  108. TextWare's image tagging, retrieving, display and output 
  109. capabilities.
  110. Retrieve-only or read-only versions are typically used to distribute 
  111. previously indexed CardFiles to other users.
  112. All of these products are easy to learn and include thorough hard-
  113. copy and on-line documentation.
  114. The TextWare Toolkit is a linkable library of documented 
  115. subroutines in C code that contain TextWare's basic indexing and 
  116. retrieval engines, but no user interface.  The Toolkit is appropriate 
  117. for users who wish to design their own interface or integrate full-
  118. text indexing and retrieval technology with other applications.
  119. The Toolkit is available for MS
  120. DOS 3.2 or greater; Novell NetWare, 
  121. 3Com 3+, 100% NETBIOS-compatible LAN software, and the Apple 
  122. Macintosh.
  123. The CardFile Concept
  124. With TextWare, many options are available to let users organize and 
  125. index existing files to form one or more on-line databases known as 
  126. CardFiles.  This process can be easily accomplished using TextWare's 
  127. defaults, or more involved if users want to produce highly 
  128. customized applications.
  129. In order to efficiently retrieve information from an on-line 
  130. database, it is most productive to divide the related text into 
  131. conveniently sized pieces, and then organize those pieces in a 
  132. logical manner.
  133. In TextWare, each conveniently sized piece of text is called a Card.  
  134. This Card is the text that will be displayed in the window once a 
  135. free-form search is finished.  A Card can be an entire file or some 
  136. portion thereof, such as a page or a paragraph.  An unlimited number 
  137. of Cards are grouped together to form a CardFile as shown in the 
  138. image window:
  139.                      Click on Image Window
  140. While Cards and CardFiles are user definable, it is important to note 
  141. that users cannot search across multiple CardFiles.
  142. The nature of the text data and its intended use will obviously 
  143. determine the appropriate definition of a Card and CardFile.  The 
  144. CardFile concept is simply a very powerful and flexible means of 
  145. allowing users to divide and then organize databases for more 
  146. efficient applications.
  147. TAG_2.PICT;1
  148. Typical TextWare Applications
  149. TextWare is ideal for creating and maintaining on-line databases, CD 
  150. ROM and other electronic publishing applications, and image storage 
  151. and retrieval systems.
  152. On-line Databases
  153. All companies create and maintain a database of information for 
  154. telephone support operations.  Such information usually includes 
  155. marketing literature, product specifications, user manuals, 
  156. technical bulletins, a log of problem and resolution reports, and a 
  157. variety of other relevant information.
  158. Many companies use TextWare to put such information on-line to be 
  159. referenced in lieu of hard-copy documents.  Such users typically 
  160. report a 100% increase in the productivity of their telephone support 
  161. groups within six months.
  162. This experience often leads companies to realize the value of on-
  163. line information, and results in a desire to distribute all or part of 
  164. the database to other functional groups.  The entire database may be 
  165. distributed to field service personnel, while product and 
  166. competitive information may be given to sales staff.  Other data, 
  167. such as policy, procedure or personnel manuals, may be added or 
  168. distributed separately.  Some of the data may even be remarketed to 
  169. a company's resellers or customers.
  170. Any "knowledge base" of hard-copy documents used by a functional 
  171. group in its day-to-day work can be made into an on-line database to 
  172. increase productivity.
  173. Electronic Publishing
  174. Full-function or retrieve-only versions of TextWare may be 
  175. distributed with the data and used on PCs, networks and even 
  176. laptops.  Or the data can reside at a central location, and users can 
  177. dial in via modem to retrieve, download and output information.Some 
  178. databases may grow to the size that CD ROM becomes the logical 
  179. medium for distribution and storage.  A single CD ROM can contain up 
  180. to 660 megabytes (MB) of data, or the equivalent of 250,000 pages 
  181. of information.  And because TextWare functions equally well with 
  182. all forms of magnetic media, users have a proven, consistent 
  183. solution regardless of the size of the database.
  184. Image Storage and Retrieval
  185. Some organizations have used TextWare imaging capabilities to 
  186. develop or integrate very sophisticated image storage and retrieval 
  187. systems.  Documents are scanned, and the resulting images are 
  188. output to a write-once, read-many (WORM) optical disk for 
  189. permanent storage.  The text in each image is converted to ASCII 
  190. text using optical character recognition (OCR) technology, and 
  191. indexed using TextWare.  Users are then able to retrieve, display and 
  192. output any document's image, ASCII text or both.
  193. Other organizations simply use TextWare to index existing 
  194. databases, and then search and retrieve information in an efficient 
  195. manner.  And professionals such as attorneys, doctors, writers, and 
  196. researchers can all benefit from TextWare.
  197. 2. Using TextWare
  198. Starting TextWare
  199. Open the TextWare Folder and double-click on the TextWare Icon.
  200. You may also open a CardFile directly by double-clicking on any of 
  201. the CardFile Icons.
  202. Entering TextWare
  203. The Text Retrieval module will retrieve, display and/or output 
  204. portions of a CardFile.  Double-click on the TextWare icon to start 
  205. the program.  Starting the program will cause a list of the available 
  206. CardFiles to appear.  Two CardFiles are included with TextWare.  One 
  207. is a set of policies and procedures for a small company, entitled 
  208. "Policies & Procedures," and the second is the on-line version of this 
  209. manual, entitled "TextWare Manual."
  210. To open one of these CardFiles, double-click on the CardFile name.  
  211. You may also change folders or drives.  Since CardFiles can be 
  212. located in any folder and on any drive, TextWare lets users easily 
  213. locate, view and select CardFiles. This is particularly convenient for 
  214. network and CD ROM environments.  
  215. For this tutorial, double-click on Policies & Procedures.CTL to open 
  216. this CardFile.
  217. Once you have selected a CardFile, the main TextWare screen will 
  218. appear as shown in the image window:
  219.                      Click on Image Window
  220. Click anywhere to open the selected CardFile.  
  221. TAG_3.PICT;1
  222. Upon opening the CardFile, the first Card and any associated image 
  223. will be displayed on the desktop as shown in the image window:
  224.                      Click on Image Window
  225. TAG_4.PICT;1
  226. Moving About in TextWare
  227. All of the functions in TextWare use menus and the Navigation Panel 
  228. to make operations as simple as possible.  The pull-down Navigate 
  229. menu has the same functions as the Navigation Panel.  However, the 
  230. menu also lists key commands for those who prefer to use the 
  231. keyboard.  The Navigate menu is shown in the image window:
  232.                      Click on Image Window
  233. The Next Card (Command =) and Previous Card (Command -) menu 
  234. selections move to the next or previous Card in the CardFile.  The 
  235. Next Hit and Previous Hit choices will be discussed later.  The Next 
  236. Image (Command ') and Previous Image (Command ;) selections move 
  237. through the images in the CardFile.  Search (Command S) is used to 
  238. perform a search.
  239. The buttons on the Navigation Panel are the same as the menu items 
  240. on the Navigate menu.  If you prefer menus or key commands, you 
  241. may hide the Navigation Panel by clicking on the close box or using 
  242. the Windows menu.
  243. TAG_5.PICT;1
  244.   The Navigation Panel is shown in the image window:
  245.                      Click on Image Window
  246. TAG_6.PICT;1
  247. On-line Help
  248. TextWare has on-line help available for a variety of subjects.  To 
  249. access help, choose Help from the Apple menu or press Command H.  
  250. Click on the desired topic and the help screens will be displayed.  If 
  251. a topic has more than one screen, you will be prompted for the next 
  252. screen.  When you are finished, click on Done to return to TextWare.  
  253. The help menu is shown in the image window:
  254.                      Click on Image Window
  255. TAG_7.PICT;1
  256. Exiting TextWare
  257. You may exit TextWare by choosing Quit from the File menu or by 
  258. pressing Command Q.  The menu is shown in the image window:
  259.                      Click on Image Window
  260. TAG_8.PICT;1
  261. Searching, Retrieving and Displaying Information
  262. Searches are performed by clicking on the Search icon on the 
  263. Navigation Panel:
  264. Searches may also be performed by selecting Search on the Navigate 
  265. menu or pressing Command S. The following window will appear as 
  266. shown in the image window:
  267. Type "holiday" (or "HOLIDAY"
  268. TextWare is not case sensitive) and 
  269. press return or click on the Search button.  Searches produce 
  270. virtually instantaneous results, regardless of the size of the 
  271. CardFile, and yield a Hit List of Cards that contain the search 
  272. criteria.
  273. TAG_9.PICT;1
  274. You will see the screen displayed in the image window:
  275.                      Click on Image Window
  276. This is the Hit List.  This list contains a 70-character, one-line 
  277. description (called a Short Display) about each Card that contains 
  278. the word "holiday."  This is particularly useful for locating the exact 
  279. Card that contains the desired information and gives users a chance 
  280. to locate text without moving through the CardFile.  While a Short 
  281. Display may have many formats, the Short Displays in this CardFile 
  282. start with the document name, then are filled with text from each 
  283. Card.
  284. TAG_10.PICT;1
  285. For this tutorial, select the first Card on the Hit List.  You should 
  286. now see the following screen displayed in the image window:
  287.                      Click on Image Window
  288. Notice how the Card's sequential number is at the bottom of the 
  289. window and the Short Display is at the top of the window.  In 
  290. addition, the full text of the Card is displayed, and the search 
  291. criterion
  292. holiday
  293. is in large, bold print and centered in the window.  
  294. Scroll through the Card using the scroll bar controls to locate 
  295. additional occurrences of the search word.
  296. As stated earlier, you may move sequentially through the CardFile 
  297. with the Next Card and Previous Card buttons.  You may also move 
  298. forward and backward through Cards on the Hit List without 
  299. returning to the Hit List.  The Next Hit List and Previous Hit List 
  300. buttons move you through the Cards on the Hit List.
  301. TAG_11.PICT;1
  302. Displaying Images
  303. If a CardFile contains images, those images will automatically be 
  304. displayed in a separate window that appears behind the Card 
  305. window. This window gives you the option of zooming in or out and 
  306. scrolling through the images associated with each Card.  
  307. A round bullet (
  308. ) preceding the Short Display indicates that an 
  309. image is tagged to the Card and will be displayed when the Card is 
  310. retrieved.  For more information on image, click on the image 
  311. window.  
  312. TAG_12.PICT;1
  313. Suppressing Text or Images
  314. Some users may wish to just display images or just display Cards.  
  315. You may suppress the Cards (text) or suppress the images.  However, 
  316. the text and images may not be suppressed at the same time. 
  317. To suppress the images, select Suppress Images from the Options 
  318. menu as shown in the image window:
  319.                      Click on Image Window
  320. Use the Next Card (Command =) and Previous Card (Command -) 
  321. buttons to scroll through the Cards.  
  322. To suppress the Cards (text), select Suppress Text from the Options 
  323. menu as shown in the image window:
  324.                      Click on Image Window
  325. Use the Next Image (Command ') and Previous Image (Command ;) 
  326. buttons to scroll through the images.  To restore the text or the 
  327. images, simply select the option again.
  328. TAG_13.PICT;1
  329. AND, OR & ANDNOT (Boolean Searches)
  330. Using the Boolean operators of and, or and andnot, you can construct 
  331. highly specific search criteria.  These operators can be combined to 
  332. form logical search expressions, and are a powerful method of 
  333. specifying, qualifying or eliminating words and ideas as you search.  
  334. This capability enables you to easily narrow your search and 
  335. efficiently find desired information.
  336. For example, if you are looking for information about holiday and 
  337. vacation in the Policies & Procedures CardFile, you might search for 
  338. "holiday" and find two occurrences, and then search for "vacation" 
  339. and find it in one Card.  You could now display all three Cards.
  340. A much simpler way to find what you are seeking is to type "holiday 
  341. and vacation" in the first search dialog box.  You may join as many 
  342. search words as you wish in this manner using the and, or and andnot 
  343. operators. 
  344. These operators all require two or more elements, or search words, 
  345. to form a logical search expression.  For example, it is not logical to 
  346. enter "and vacation" or "andnot holiday" when there is no previous 
  347. element for it to be compared against.
  348. You may type all query words and Boolean operators in the first 
  349. search area of the dialog box or you may type each word in a 
  350. separate box as shown in the image window:
  351. To move to another section in the dialog box, simply press the tab 
  352. key or click on the desired box.  Select one of the sample data 
  353. CardFiles, and experiment with these operators on your own.
  354. For more information, see the Text Retrieval - and, or and andnot 
  355. section.
  356. TAG_30.PICT;1
  357. Phrase and Proximity Searches
  358. TextWare also supports phrase searches and proximity searches.  
  359. Phrase searches allow you to find the occurrences of a phrase, or 
  360. group of words, in a specific order.  Proximity searches allow you to 
  361. find the occurrences of two or more words within ten words of one 
  362. another.
  363. Phrase Search
  364. To perform a phrase search, click on the Search icon.  Then in the 
  365. dialog box type the phrase or group of words within quotes (" ").  For 
  366. example, select the Policies & Procedures CardFile.  Click on the 
  367. Search icon and type "1989 holiday schedule" and press return or 
  368. click on Search.  The Hit List will then display those Cards which 
  369. contain this specific phrase.
  370. Proximity Search
  371. To perform a proximity search, click on the Search icon.  Then in the 
  372. dialog box type two or more words within brackets ([ ]).  TextWare 
  373. will find the occurrences of the words within ten words of one 
  374. another.  For example, click on the Search icon and type [employee 
  375. insurance] and press return or click on Search.  The Hit List will then 
  376. display those Cards which contain these words within ten words of 
  377. one another. 
  378. Wildcard Searches
  379. Both "*" and "?" wildcards can be included within or at the end of any 
  380. word.  Wildcards may not be placed at the beginning of a word.
  381. For example, in the search dialog box in the Policies & Procedures 
  382. CardFile, type "incur*" and press return to execute the search.  Then 
  383. type "cal?nd?r" and press return to execute the search.  Wildcards 
  384. are a convenient way to locate various derivatives of a word or 
  385. words with uncertain spellings.
  386. Printing Text and Images
  387. TextWare allows you to print both Cards and Images on any Chooser-
  388. selectable printer such as the LaserWriter or ImageWriter.  Simply 
  389. locate the Card you wish to print and select Print on the File menu 
  390. for the Card data or Print Image on the File menu to print the image.  
  391. You may also press Command P to print the Card.
  392. A window similar to the following will appear as shown in the 
  393. image window:
  394.                      Click on Image Window
  395. Click on OK or press return to print the Card.  Click on the Cancel 
  396. button if you decide not to print at this time.
  397. TAG_14.PICT;1
  398. You may also change the font for the Card from the default of 9 
  399. points to 12 points.  To do this select Use 12 point Font from the 
  400. Options menu or press Command T as shown in the image window:
  401.                      Click on Image Window
  402. To return to the default 9-point font select Use 9 point Font from 
  403. the Options menu or press Command T as shown in the image 
  404. window:
  405.                      Click on Image Window
  406. You may change the paper size, orientation and other print options by 
  407. selecting Page Setup from the File menu.
  408. TAG_15.PICT;1
  409. Using the Clipboard
  410. TextWare provides full support for the Macintosh Clipboard. To 
  411. transfer text from a Card to other applications select (highlight) the 
  412. text you wish to copy and choose Copy from the Edit menu as shown 
  413. in the image window:
  414.                      Click on Image Window
  415. At this point the selected text is in the Clipboard, ready to be pasted 
  416. into another application.  You may copy the entire Card by choosing 
  417. Select All (or pressing Command A), then choosing Copy from the 
  418. Edit menu (or pressing Command C).
  419. Images may be copied by bringing the Image window to the front and 
  420. choosing Copy from the Edit menu. At this point the selected image 
  421. is in the Clipboard, ready to be pasted into another application.
  422. TAG_16.PICT;1
  423. 3.Text Indexing
  424. Building the Database
  425. Today most text databases are created with word processing or 
  426. desktop publishing software packages, or through the use of 
  427. scanners and OCR technology.  Additional text data may be 
  428. downloaded from mainframe computers or on-line databases offered 
  429. by third parties.
  430.  
  431. Images, graphics or other types of data may be added using a variety 
  432. of software packages and peripherals.  The result is a large and 
  433. ever-growing number of related but unstructured files.  As a result, 
  434. organizing the database is an important step in the construction of 
  435. on-line databases.  With TextWare, many options are available to let 
  436. you organize and index existing files to form one or more on-line 
  437. databases known as CardFiles.  This process can be easily 
  438. accomplished using TextWare's defaults, or more involved if you 
  439. want to produce highly customized applications.
  440. The CardFile Concept
  441. In order to efficiently retrieve information from an on-line 
  442. database, it is most productive to divide the related text into 
  443. conveniently sized pieces and then organize those pieces in a logical 
  444. manner.
  445. In TextWare, each conveniently sized piece of text is called a Card.  
  446. A Card can be an entire file or some portion thereof, such as a page 
  447. or a paragraph.  An unlimited number of Cards are grouped together 
  448. to form a CardFile as shown in the image window:
  449.                      Click on Image Window
  450. The nature of text data and its intended use will obviously 
  451. determine the appropriate definition of a Card and CardFile.  The 
  452. CardFile concept is simply a very powerful and flexible means of 
  453. allowing you to divide and then organize databases for more 
  454. efficient applications.
  455. TAG_2.PICT;1
  456. Organizing the Text Data
  457. TextWare lets you index text files created with a word processor.  
  458. However, text files created with a word processor must be saved in 
  459. a certain manner, as summarized below:
  460. MacWrite        Save files as "Text."
  461. Microsoft Word    Save files as "Text Only with Line Breaks."
  462. WordPerfect        Save files as "Mac Text (SR to CR) "
  463. During the indexing process, TextWare divides text files into Cards.  
  464. It is important to note that files will be indexed in a specific order 
  465. based on their file names.  Files will be indexed alphabetically in 
  466. ascending order, and Cards will be numbered sequentially beginning 
  467. with the first Card in the first file indexed.  Therefore, it may be 
  468. necessary to rename some of your text files in order to produce the 
  469. desired sequence of Cards.
  470. Consult TextWare Technical Support for information concerning 
  471. other word processors.
  472. Defining Cards
  473. A Card will always be the smallest piece of text that will be 
  474. retrieved and displayed if it contains the search criteria.
  475. To assist you in dividing files into individual Cards, TextWare 
  476. enables you to automatically define a Card to be an entire file, a 
  477. page, a paragraph or a certain number of lines.  You may also 
  478. manually format the text file so that a Card may be any chunk of 
  479. text.
  480. To automatically define a Card, choose the desired Card size from 
  481. the Delimiter menu.  The Card may be an entire file, a page of a file, 
  482. a paragraph or a certain number of lines.
  483. To divide files into virtually any size chunk of text, use a text editor 
  484. to manually insert the #CARD code, followed by a carriage return, at 
  485. the beginning of the chunk of text, then an #ENDCARD code, also 
  486. followed by a carriage return, at the end.  The #CARD and #ENDCARD 
  487. codes must be located at the left margin.  Whatever information is 
  488. between #CARD and #ENDCARD will be defined as a Card by TextWare 
  489. during the indexing process.
  490. The only constraint is that a Card cannot be larger than 16 KB, or 
  491. approximately 8 full pages of single-spaced text.  Since few 
  492. implementations will require the use of larger Cards, this should not 
  493. be a significant constraint.
  494. You may also define a 70-character, one-line Short Display of 
  495. information for each Card, which TextWare will display on the Hit 
  496. List of Cards that contain the search criteria.  You may choose to 
  497. automatically define the display to be the file name, the file name 
  498. plus the first characters of text in each Card, or the first 70 
  499. characters of text in each Card.  Since the Hit List is displayed prior 
  500. to the full text of any Card, this description should assist users in 
  501. selecting which Card is most likely to contain the information 
  502. desired.
  503. These options will permit you to easily and quickly define a Card as 
  504. virtually any piece of text, and address any application 
  505. requirements.
  506. Tagging Images to Cards
  507. Because a Card is the smallest piece of text in a CardFile, it is also 
  508. the logical basis for building relationships between a piece of text 
  509. and other data, such as a graphic image. This is accomplished by 
  510. tagging this information to the Cards.
  511. One image may be tagged to one or more Cards to supplement the 
  512. text data.  In this case, when the Hit List is displayed you will also 
  513. be alerted to the existence of the tagged images.  Cards with images 
  514. will have a bullet (
  515. ) preceding the Short Display.  When a Card with 
  516. an image is selected the image will automatically be retrieved and 
  517. displayed behind the text window.
  518. TextWare supports images in the Macintosh PICT and TIFF formats.  
  519. TextWare also supports images in the MS
  520. DOS CUT, PCX and TIF 
  521. formats.  Images in the MS
  522. DOS CUT and PCX formats will 
  523. automatically be converted to the Macintosh PICT format for display 
  524. purposes.
  525. Tagging images is accomplished prior to the indexing process by 
  526. placing the tags in the ASCII text file to be indexed.  This file must 
  527. contain #CARD and #ENDCARD commands.  For further information on 
  528. tagging images, refer to Tagging Images in the Reference Guide 
  529. section.
  530. Other Options
  531. A variety of other options are also available for building a CardFile, 
  532. and can be implemented prior to the indexing process through the use 
  533. of special files and commands.  These include the following 
  534. capabilities:
  535.     You can create a list of stopwords that may be present in the 
  536. CardFile but will not be indexed.  As a result, if they are included in 
  537. a search expression, they will not be located and the search will 
  538. produce no results for those words.  This is done by creating a 
  539. custom ".STP" stopword file.
  540.     Non-alphanumeric ASCII characters, such as a dollar sign or 
  541. period, and non-recognizable characters inadvertently produced by 
  542. scanning and OCR equipment can be indexed, or they can be excluded 
  543. from the indexing process.  This is done by creating a custom .HDR 
  544. header file with the #LETTERS, #EMBED and #BADCHAR commands.
  545.     You can develop a custom startup screen which will be 
  546. displayed every time a user accesses a CardFile.  This is done by 
  547. creating a custom .SUP startup file.
  548. These options are available to let you address all types of databases 
  549. and potential applications when building a CardFile.  Hence, you can 
  550. build CardFiles using a unique set of custom files for all CardFiles 
  551. to address a wide variety of data.
  552. Indexing CardFiles
  553. Once a CardFile has been organized, the actual indexing process is 
  554. automatic and fast.  While indexing times vary depending upon the 
  555. nature of the text data, most CardFiles can be indexed at a rate of 4 
  556. to 10 MB of data per hour depending on the Macintosh used.
  557. As a result of TextWare's proprietary indexing algorithm, the size of 
  558. the related index is small and inversely proportional to the size of 
  559. the database.  The size of the index as a percentage of the size of 
  560. the text data is typically as follows:
  561.                      Size of          Size of
  562.                     Text Data           Index   
  563.                   Up to 1 MB        20 to 40%
  564.                    l to 5 MB        15 to 25%
  565.                   5 MB Plus            10 to 15%
  566. When indexing, you should have free hard disk space of at least 150% 
  567. of the size of the related text data.
  568. A Step-by-Step Example
  569. This step-by-step indexing example will use Microsoft Word files 
  570. that have been saved as text with line breaks.  These are the same 
  571. files that were used to create the Policies & Procedures CardFile.  
  572. These files are located in the Sample Input folder and are called 
  573. SAMPLE 1, SAMPLE 2, and SAMPLE 3.  All three files will be combined 
  574. to form a CardFile called Sample.  For this example, a Card will be 
  575. defined as a page, and the Short Display will be the file name and the 
  576. first part of the text in each Card.  Custom header and stopword 
  577. files
  578. SAMPLE.HDR and SAMPLE.STP
  579. have been provided and will be 
  580. used.  
  581. Here are step-by-step indexing instructions:
  582. Step 1.    Locate the "Sample Input" folder.  This folder contains            
  583. Microsoft Word files that have been saved as text.
  584. Step 2.    Create an empty folder to hold the output files.  Copy 
  585. SAMPLE.HDR and SAMPLE.STP to this folder.
  586. Step 3.    Double-click on the TextWare Index icon and the console 
  587. screen will appear as shown in the image window:
  588.                      Click on Image Window
  589. TAG_17.PICT;1
  590. Step 4.    Select the Card size delimiter from the Delimiter menu. 
  591. These choices control the make-up of each Card in your database.  
  592. This is what will determine the definition of each Card in the 
  593. CardFile.  A Card may be a file, a page of a text file, a paragraph in a 
  594. text file, a certain number of consecutive lines or any chunk of text 
  595. if you want to use the #CARD and #ENDCARD commands.  For this 
  596. tutorial, choose Page from the delimiter menu as shown in the image 
  597. window:
  598.                      Click on Image Window
  599. TAG_18.PICT;1
  600. Step 5.    Select your Short Display choice from the Short Display 
  601. menu. These choices allow control over what the user will see on the 
  602. Hit List.  This Short Display may contain the file name, the file name 
  603. and up to 70 characters from each Card or the first 70 characters of 
  604. each Card.  For this tutorial choose "File Name + First Part of Card" 
  605. as shown in the image window:
  606.                      Click on Image Window
  607. TAG_19.PICT;1
  608. Step 6.    Select Index from the File menu as shown in the image 
  609. window:
  610.                      Click on Image Window
  611.  
  612. TAG_20.PICT;1
  613. Step 7.    The following screen will appear as shown in the image 
  614. window:
  615.                      Click on Image Window
  616.     Choose the folder you created earlier in Step 2 for your output 
  617. files and enter the name of the CardFile as SAMPLE.  Click on Save or 
  618. press return.
  619. TAG_21.PICT;1
  620. Step 8.     This screen will appear next as shown in the image 
  621. window:
  622.                      Click on Image Window
  623.     At this point you are being asked to select the folder that 
  624. contains the data you want to index.  Choose the Sample Input folder, 
  625. which contains the text files to be indexed (note: the actual files 
  626. will not be displayed) and then click on Index. This starts the 
  627. indexing process. The status of the indexing will be displayed and a 
  628. summary of indexing statistics will be shown when indexing is 
  629. finished.  Information about the CardFile will be displayed in a Log 
  630. File, with the name of the CardFile and a .LOG extension, in the 
  631. output folder.
  632. Step 9.    Once the indexing is complete, you may choose Quit from 
  633. the File menu to exit the indexing application.  You can now conduct 
  634. searches in the new SAMPLE CardFile.
  635. TAG_22.PICT;1
  636. The Indexing Process
  637. The step-by-step indexing example demonstrated the indexing 
  638. process but did not explain how TextWare actually creates a 
  639. CardFile.  This section will briefly describe that process.
  640. Prior to indexing you may have created custom files to be used by 
  641. TextWare when indexing the related text files and CardFile.  These 
  642. files must be located in the folder that will contain the completed 
  643. CardFile.  This can be done outside of TextWare using a word 
  644. processor, creating a text file with the proper extension:
  645.     Stopword File    .STP
  646.     Header File        .HDR
  647.     Startup Screen    .SUP
  648. During the indexing process, TextWare refers to the name of the 
  649. CardFile and then checks to see if any related custom files have been 
  650. created.  If so, TextWare uses those files.  If not, TextWare does not 
  651. create stopword, startup or header files.
  652. TextWare then creates a Log File, with the name of the CardFile and 
  653. a .LOG extension, to record all of the information displayed during 
  654. indexing.  This file contains information about the indexing process.
  655. When the indexing process is completed, a total of six to nine unique 
  656. files will exist with the name of the CardFile and the following 
  657. extensions:
  658.     Stopword File    .STP        Bit Strings File    .KDT
  659.     Header File        .HDR        Text Data            .CDT
  660.     Startup File    .SUP        Short Display        .CNX
  661.     Log File        .LOG        Word List File        .KEY
  662.                                 Control File    .CTL
  663. The files in the left column have been described above.  The .SUP, 
  664. .STP, and .HDR files will exist only if you created them prior to the 
  665. indexing process, and explains why the number of unique files will 
  666. vary.
  667. The files in the right column are created during the indexing process 
  668. and contain the CardFile's indexes and related information.
  669. In addition, when you first access a newly created CardFile, 
  670. TextWare will create a Quick Load file with the name of the CardFile 
  671. and a .QLD extension.  This file allows you to access CardFiles 
  672. faster.
  673. It is important to remember that any preexisting files with the 
  674. same file name as those created by TextWare will be overwritten 
  675. during the indexing process.
  676. Users who desire more detailed information should consult the 
  677. appropriate sections in the Reference Guide.
  678. 4. Questions and Answers
  679. Common Problems and Questions
  680. Q:    No matter what options I choose, the indexing function bombs 
  681. out.  What am I doing wrong?
  682. A:    Check the Log File for error messages.  If no Log File exists, 
  683. you may not have sufficient free hard disk space available.  
  684. TextWare requires free hard disk space equal to or greater than 
  685. 150% of the size of the data to be indexed.  You should free up 
  686. sufficient hard disk space and try again.
  687. Q:    Is there a maximum word length?
  688. A:     Yes. The indexing process will not index words more than 78 
  689. characters long.  Words longer than 78 characters will be truncated.
  690. Q:    Why aren't changes in the stopword and header files reflected 
  691. in my CardFile?
  692. A:    Changes to the stopword (.STP) and header (.HDR) files may 
  693. only be implemented prior to indexing a CardFile.  If the files are 
  694. changed after indexing, the changes will not be implemented and you 
  695. may corrupt your CardFile.
  696. Q:    When indexing, some files in the folder are not indexed.  Why?
  697. A:    TextWare indexes only those files that have been saved as text.  
  698. If a file is not converted to text, it cannot be indexed.  Use your 
  699. word processor to save all files as text files.
  700. Q:    Is there a limit to the size of a Card?
  701. A:    Yes, a Card may not be greater than 16 KB in size.
  702. Q:    When I retrieve a Card with an image I receive the error 
  703. message "Error Opening File {:IMAGES:Image.pict} IoErr=-120."  What 
  704. could be causing this?
  705. A:    Check line 21 of the CardFile's control (.CTL) file.  This should 
  706. contain the full path to your images.  If the path is not correct, 
  707. TextWare will not be able to locate the desired images.  Also, check 
  708. to make sure the image is in the PICT format.
  709.                             Reference Guide
  710.  The#CARD/#ENDCARD Commands
  711. If your want to define Cards to be some chunk of text other than one 
  712. of the choices that are automatically available, or you want to tag 
  713. images to Cards, you need to learn to use the #CARD and #ENDCARD 
  714. commands.
  715. You must use a text editor to edit the files to be indexed and 
  716. manually insert these commands.  Cards will then be defined by the 
  717. placement of these commands:
  718.      #CARD
  719.     #ENDCARD
  720. Both of these commands must be against the left margin.  All text 
  721. between the #CARD and #ENDCARD will be defined as a single Card.  
  722. Any text outside of these commands will be ignored when the file is 
  723. indexed.  As a result, every #CARD must have a matching #ENDCARD.  
  724. Below is a sample Card:
  725.     #CARD
  726.     This is the first test Card for TextWare.  Notice how
  727.     the commands are located at the left margin.  
  728.     Everything between the commands will be considered
  729.     a Card when the file is indexed.
  730.     #ENDCARD
  731. When you are finished placing the commands in the file, save the file 
  732. and start the indexing process.  Choose #CARD + #ENDCARD from the 
  733. Delimiter menu as shown in the image window:
  734.                      Click on Image Window
  735. CD ROM/Electronic Publishing 
  736. Publishing CardFiles on a CD ROM or some other form of magnetic 
  737. media can be complex and requires some special considerations.  You 
  738. should read this overview and contact technical support for 
  739. additional information or assistance.  You may also want to inquire 
  740. about the various electronic publishing agreements and pricing 
  741. arrangements that are available.
  742. In order to electronically publish a CardFile, you must create and 
  743. distribute all of the files associated with that CardFile, and you 
  744. must distribute or the recipient must already have a retrieve-only 
  745. version of TextWare.
  746. The files needed are as follows:
  747. 1.    You must include those files with the CardFile name and 
  748. following extensions:
  749.                        .CTL
  750.                        .CDT
  751.                        .CNX 
  752.                        .KEY
  753.                        .KDT
  754.                        .QLD
  755. 2.    If you have tagged images or other data to Cards, you must 
  756. include those files.
  757. 3.    You may have created and want to include those files with the 
  758. CardFile name and the following extensions:
  759.             .HDR
  760.             .STP
  761.             .SUP
  762. 4.    If you are distributing a retrieve-only version of TextWare, 
  763. you must include the retrieval files (the TextWare retrieval program 
  764. and the on-line manual files).
  765. Many electronic publishers use the .SUP file to display their logo, 
  766. name, address, phone number and similar information.
  767. If you are electronically publishing a CardFile on a CD ROM, you 
  768. should note the following:
  769. 1.    The International Standard Organization's (ISO's) 9660 
  770. standards for the Macintosh require a ;1 at the end of each file name.  
  771. The CardFile's control (.CTL) file must be edited to include these 
  772. characters.
  773. 2.    You must not have a drive letter specified in the CardFile's 
  774. control (.CTL) file.
  775. Publishing CardFiles on a CD ROM or some other form of magnetic 
  776. media can be complex.  Publishing CardFiles for use on both MS
  777. DOS-
  778. based PCs and Macintoshes is even more complex.  Experiment on 
  779. your own and call technical support with any questions that arise.
  780. Control File Format 
  781. During the indexing process TextWare creates several files for each 
  782. CardFile, including a file with the CardFile name and a .CTL 
  783. extension.  This file is called the control file and contains important 
  784. information about the CardFile.
  785. Advanced users may want to edit a CardFile's control file using a 
  786. text editor, or technical support may occasionally need to lead you 
  787. through that process.  For these purposes, a brief description of the 
  788. control file format is included. 
  789. The Policies & Procedures CardFile control file is shown below:
  790.       Line #
  791.     1    300 Macintosh
  792.     2    :TEXTWARE:policies.CDT
  793.     3    :TEXTWARE:policies.CNX
  794.     4    :TEXTWARE:policies.KDT
  795.     5    :TEXTWARE:policies.KEY
  796.     6    :TEXTWARE:policies.RLC
  797.     7    :TEXTWARE:policies.ROM
  798.     8    :TEXTWARE:policies.ALS
  799.     9    :TEXTWARE:policies.STP
  800.     10    :TEXTWARE:policies.HDR
  801.     11    :TEXTWARE:policies.BCH
  802.     12    :TEXTWARE:policies.LOG
  803.     13    :TEXTWARE:policies.SUP
  804.     14    :TEXTWARE:policies.QLD
  805.     15    :TEXTWARE:policies.DOC
  806.     16    1 0 0 -1 80 twreport.txt
  807.     17    2 10 1 -1 -1 0 1
  808.     18    255
  809.     19    0 0 0 0 0 EDLIN
  810.     20    Sample Data - Policies and Procedures
  811.     21    :IMAGES:
  812.     Line 1:            The TextWare version number (3.00) 
  813.                     used in the indexing process.
  814.     Lines 2 through 15:    The full path to and name of all files       
  815.                     associated with the CardFile.
  816.     Line 16 through 20:    Used by MS
  817. DOS-based PCs who access 
  818.                     the CardFile.
  819.     Line 21:            The full path to the location of data 
  820.                     tagged to Cards.
  821. Exiting TextWare
  822. You may exit Text Retrieval by choosing Quit from the File menu or 
  823. by pressing  Comman Q.  The File menu from the Text Retrieval 
  824. module is shown in the image window:
  825.                      Click on Image Window
  826. You may exit Text Indexing by choosing Quit from the File menu.  The 
  827. File menu from Text Indexing module is shown in the image window:
  828.                      Click on Image Window
  829. TAG_24.PICT;1
  830. Header File
  831. The Header File contains specific information relevant to creating a 
  832. CardFile.  If you wish to search for numbers that contain commas 
  833. (12,000), dollar amounts or decimals ($12.50), special characters 
  834. (#,<,>,-) or fractions (2/3), the special characters needed to index 
  835. these words must be in the header file.  
  836. Each time you create a CardFile TextWare checks to see if you have 
  837. already created a custom header file with the name of the CardFile 
  838. and a .HDR extension.  
  839. If you want to create a custom header file, you must do so before 
  840. indexing.  Once a CardFile has been created, the header file must 
  841. remain unchanged and cannot be altered in any manner.  To do so 
  842. would risk damaging the CardFile.
  843. To create a custom header file, use a text editor to create a text file 
  844. with the name of the CardFile and a .HDR extension.  Then enter one 
  845. or more of the following commands in the proper format:
  846.         #LETTERS
  847.         #EMBED
  848.         #BADCHAR
  849. A sample header file, SAMPLE.HDR, is included in the sample input 
  850. folder.  You may edit this file and/or rename it for each CardFile 
  851. created.  The SAMPLE.HDR file contains the following commands:
  852.         #LETTERS -$<>#
  853.         #EMBED .,/'
  854.         #BADCHAR ^
  855. Please consult the following individual command sections for more 
  856. information about these commands.
  857. Header File - #BADCHAR Command
  858. Text files produced via scanning and OCR technology may contain 
  859. unrecognizable characters.  TextWare provides a facility for marking 
  860. such characters and other characters which cannot be interpreted 
  861. with a simple reminder, such as ^ or !.  Then, if during the indexing 
  862. process TextWare finds a character or a string of characters which 
  863. it cannot index, TextWare will insert the marker in place of that 
  864. character.  The bad character marker in the SAMPLE.HDR file is ^.
  865. You may create custom header files for specific CardFiles.  Allow 
  866. one space after the #BADCHAR command and then type the letter you 
  867. wish to use as the marker, as shown here:
  868.         #BADCHAR ^
  869. Header File - #EMBED Command
  870.  
  871. TextWare allows you to index non-alphanumeric characters as 
  872. letters only if they are embedded in a string of alphanumeric 
  873. characters.
  874. For example, if a period is indexed only when it is surrounded by 
  875. alphanumeric characters, then 20.5 can be found easily but periods 
  876. at the end of sentences will not be included in words.  The same is 
  877. true of commas in numbers like 1,200 for dates or fractions such as 
  878. 2/3 or 01/10/91 and for apostrophes in words like didn't and can't.
  879. You can define these characters by changing the #EMBED command in 
  880. the SAMPLE.HDR header file, or you can create custom header files 
  881. for specific CardFiles.  Allow one space after the #EMBED command 
  882. and then type the characters you wish to include, as shown here:
  883.         #EMBED .,/'
  884. Header File - #LETTERS Command 
  885. TextWare allows you to index non-alphanumeric characters as 
  886. letters.  The ability to index these characters is valuable, and 
  887. necessary for some applications.  For example, if you wish to search 
  888. for A-1, #3, $15.45 or #, the hyphen (-), the dollar sign ($), and the 
  889. pound sign (#) must be defined in the header file with the #LETTERS 
  890. command.
  891. You can define these characters by creating custom header files for 
  892. specific CardFiles.  Allow one space after the #LETTERS command 
  893. and then type the characters you wish to include, as shown in the 
  894. first line from the file SAMPLE.HDR below:
  895.         #LETTERS -$<>#
  896. Help
  897. On-line Help is accessible from the Apple menu whenever TextWare 
  898. is active.  TextWare has a number of different help options available.  
  899. Choose Help from the Apple menu or press Command H.  The 
  900. following screen will appear as shown in the image window:
  901.                      Click on Image Window
  902. Click on the desired help option for further information.  When 
  903. finished press return or click on the Done button.
  904. TAG_7.PICT;1
  905. Hit List
  906. After a search has been executed, a list of 70-character, one-line 
  907. Short Displays of information for each Card is displayed.  This is 
  908. known as the Hit List.  The Hit List from the search for "holiday" in 
  909. the Policies & Procedures manual is shown in the image window:
  910.                      Click on Image Window
  911. You may scroll through the Hit List with the scroll bar and double-
  912. click on a Short Display to retrieve the related Card, or you may 
  913. click on  Cancel to return to the previously displayed Card.  When 
  914. viewing a Card, you may use the Navigation Panel or the Navigate 
  915. menu to move through the Cards on the Hit List or all Cards in the 
  916. CardFile.
  917. TAG_10.PICT;1
  918. When viewing Cards, to return to the Hit List, select Return To Hit 
  919. List from the Windows menu or press Command R as shown in the 
  920. image window:
  921.                      Click on Image Window
  922. The 70-character, one-line Short Display is user definable.  See 
  923. Short Display for more information.
  924. TAG_25.PICT;1
  925. Images
  926. TextWare for the Macintosh includes the capability to retrieve, 
  927. display and print images.  Please refer to Text Retrieval - Displaying 
  928. Images and Text Retrieval - Printing Images for more information.
  929. Log File 
  930. During the indexing process TextWare creates a Log File with the 
  931. name of the CardFile and a .LOG extension to record all of the 
  932. information displayed during indexing.
  933. If a problem arises and the indexing process is terminated, you 
  934. should use a text editor to view the contents of the Log File.  This 
  935. will help you to diagnose and correct indexing problems.  The Log 
  936. File for the Policies & Procedures Manual is shown below:
  937.     ---------------------------------------------
  938.     Begin Index Result = {}
  939.     ---------------------------------------------
  940.     Policies Manual     , 16610 bytes, 40.254 Mb/hr
  941.     ---------------------------------------------
  942.     End Indexing Result = {[00] No error}
  943.     ---------------------------------------------
  944.     TextWare
  945.  Index Summary
  946.     .... 16610 Total bytes
  947.     .... 8 Cards
  948.     .... 1 Files
  949.     .... 0 Directories
  950.     .... 43 Seconds
  951.     .... 1.303 Mb/hr
  952.     ---------------------------------------------
  953. Short Display 
  954. After a search has been executed, a list of 70-character, one-line 
  955. descriptions is displayed.  This is known as the Hit List.  Each line is 
  956. the Short Display for the related Card.  The Short Display is user 
  957. definable, and should assist users in selecting which Card is most 
  958. likely to contain the information desired.  The Short Display type is 
  959. specified during the indexing process.  During indexing, select the 
  960. desired Short Display type on the Short Display menu as shown in the 
  961. image window:
  962.                      Click on Image Window
  963. The three options available are summarized below:
  964. File Name                    Each Short Display in the CardFile
  965.                         will have only the file name as its
  966.                          Short Display.
  967. File Name + First Part of Card    Each Short Display in the CardFile
  968.                         will begin with the file name, 
  969.                         with the remaining available 
  970.                         space filled with the first     
  971.                         characters in each Card.
  972. First Part of Card            Each Short Display will be the 
  973.                         first 70 characters in the Card. 
  974. TAG_19.PICT;1
  975. Startup Screen
  976. You may develop a startup screen that will be displayed every time a 
  977. user accesses a CardFile.  This feature is useful to provide 
  978. customized instructions or information about the CardFile prior to 
  979. displaying the first Card or doing a search.
  980. To create a startup screen, use a graphics program to create a 
  981. Macintosh PICT graphic file with an image no larger than 500 pixels 
  982. wide by 300 pixels high in size.  Save this file with the CardFile 
  983. name and a .SUP extension.  
  984. The startup screen must be placed in the same folder as the CardFile 
  985. and will be used to replace the existing TextWare screen when text 
  986. retrieval is accessed.
  987. Stopwords 
  988. Before you create a CardFile, you may define a list of words that 
  989. will not be indexed.  These are called stopwords.  Stopwords will 
  990. appear in a CardFile's index as such, and can be included in a search 
  991. expression but will yield no results.
  992. Each time you create a CardFile TextWare checks to see if you have 
  993. already created a custom stopword file with the name of the 
  994. CardFile and a .STP extension.  If a stopword file does not exist, all 
  995. words in the text will indexed.
  996. If you want to create a custom stopword file, you must do so before 
  997. indexing.  Once a CardFile has been created, the stopword file must 
  998. remain unchanged and cannot be altered in any manner.  To do so 
  999. would risk damaging the CardFile.
  1000. To create a custom stopword file, use a text editor to create a file 
  1001. with the name of the CardFile and the .STP extension.  Stopwords are 
  1002. defined in a stopword file by putting the words to be included on one 
  1003. or more lines with a space between each word.
  1004. Included in the Sample Input folder is a stopword file called 
  1005. SAMPLE.STP.  You may use a text editor to modify this file or simply 
  1006. rename this file to be used during indexing.  The SAMPLE.STP file is 
  1007. shown below:
  1008.         a an and are as
  1009.         be been bring
  1010.         can could
  1011.         in is
  1012.         on or
  1013.         the these this to
  1014.         was were with
  1015. Increasing or decreasing the number of stopwords will not 
  1016. significantly affect the size of a CardFile's index.
  1017. Tagging Images
  1018. If you want to tag images to Cards you must use the delimiter 
  1019. commands of #CARD and #ENDCARD  and manually define each 
  1020. individual Card.  Then you must tag the images to Cards using the 
  1021. command of #TAG .
  1022. For additional information refer to the #CARD/#ENDCARD and #TAG 
  1023. sections.
  1024. The #TAG Command
  1025. The #TAG command is used to tag image files to Cards.  The #TAG 
  1026. command is used in conjunction with the #CARD and #ENDCARD 
  1027. commands. You must use a text editor to edit the files to be indexed 
  1028. and manually insert these commands.
  1029. All commands must be against the left margin.  All text between the 
  1030. two commands of #CARD and #ENDCARD will be a Card.  Any text 
  1031. outside of these commands will be ignored when the file is indexed.  
  1032. As a result, every #CARD must have a matching #ENDCARD. 
  1033.  
  1034. Below is a portion of the command file for the Policies & Procedures 
  1035. manual:
  1036.      #TAG policies.pct
  1037.      #CARD
  1038.                           SUMMIT COMPANY, INC.
  1039.                       POLICIES AND PROCEDURES
  1040.      INTRODUCTION
  1041.      Welcome to Summit Company, Inc.  This document
  1042.      summarizes basic policies and procedures which will
  1043.      be most important as the Company grows.  Personnel
  1044.      will review this document with you, as well as all of
  1045.      the necessary payroll and benefit related documents 
  1046.      and forms during your first week of employment.
  1047.      Again, welcome to Summit.  We look forward to a long
  1048.      and mutually rewarding relationship.
  1049.      #ENDCARD
  1050. Upon the completion of the indexing process, use a text editor to 
  1051. edit line 21 of the CardFiles's control (.CTL) file to refer to the 
  1052. location of the image files.
  1053. When you have finished placing the commands in the file, save the 
  1054. file and start the indexing process.  Choose "#CARD + #ENDCARD" 
  1055. from the Delimiter menu as shown in the image window:
  1056.              Click on Image Window
  1057. For additional information, refer to the #CARD/#ENDCARD and 
  1058. Tagging Images sections.
  1059. TAG_26.PICT;1
  1060. Text Indexing
  1061. A thorough description of how to create CardFiles is included in the 
  1062. Text Indexing portion of the Getting Started section of this manual.  
  1063. That description includes a step-by-step example that leads you 
  1064. through the process of creating the files, selecting a Short Display, 
  1065. selecting the Card delimiter and indexing.  However, you should note 
  1066. the following:
  1067. During the indexing process, TextWare divides text files into Cards.  
  1068. It is important to note that files will be indexed in a specific order 
  1069. based on their file names.  Files will be indexed alphabetically in 
  1070. ascending order, and Cards will be numbered sequentially beginning 
  1071. with the first Card in the first file indexed.  Therefore, it may be 
  1072. necessary to rename some of your text files in order to produce the 
  1073. desired sequence of Cards.
  1074. Text Retrieval
  1075. A thorough description of the Text Retrieval module is included in 
  1076. the Getting Started section of this manual.
  1077. The following sections will explain individual features and 
  1078. functions in more detail.
  1079. Text Retrieval - AND, OR & ANDNOT Commands 
  1080. Using the simple Boolean operators of and, or and andnot, you can 
  1081. construct highly specific search criteria.  The use of these ideas as 
  1082. operators is called logical grouping, and is a powerful method of 
  1083. specifying, qualifying or excluding words and ideas as you search.  
  1084. This capability enables you to narrow your search and retrieve only 
  1085. the information desired.
  1086. For example, if you want to look for information about insurance and 
  1087. spouses, you might search for "insurance" and find four occurrences, 
  1088. and then search for "spouses" and find two occurrences.  You might 
  1089. now go through all the Cards that contain "spouses" to find ones that 
  1090. contain "insurance."  A much simpler way to find what you want is to 
  1091. search for "insurance and spouses."  You may join as many search 
  1092. words as you wish together in this manner with the and, or and 
  1093. andnot operators.
  1094. These operators all require two elements, or search words, to work.  
  1095. For example, if you have done no previous searches, it is not logical 
  1096. to type "and vacation."  It will also not work to simply type "andnot 
  1097. holiday" when there is no previous element for TextWare to compare 
  1098. against.
  1099. You may type all query words and Boolean operators in the large 
  1100. "Search for" area in the dialog box or you may type each word in a 
  1101. separate box as shown in the image window:
  1102.              Click on Image Window
  1103. To move to another section in the dialog box simply press the tab 
  1104. key or click on the desired box.
  1105. TAG_27.PICT;1
  1106. The following is an explanation of the three operators, or commands, 
  1107. you may use to make your searches more precise and efficient:
  1108.     AND        Selects Cards which contain both or all of the 
  1109.             words for which you are searching, such as "holiday 
  1110.             and vacation and Thanksgiving."  The and operator is 
  1111.             assumed whenever a space is left between words.  
  1112.             For example, entering "Thanksgiving holiday" would 
  1113.             be the same as entering "Thanksgiving and holiday" 
  1114.             (but it would not be the same as searching for the 
  1115.             phrase "Thanksgiving holiday").
  1116.     OR        Selects Cards which contain any one of the words 
  1117.             for which you are searching, such as "holiday or 
  1118.             vacation or Thanksgiving."
  1119.     ANDNOT     Selects Cards which contain one word but not 
  1120.             another.  For example, you might look for a Card 
  1121.             with the word Thanksgiving without the word 
  1122.             holiday by entering "Thanksgiving andnot holiday."  
  1123.             andnot only works with a previous search word.  
  1124.             You cannot enter "andnot holiday" and retrieve all 
  1125.             the Cards which do not contain that word unless 
  1126.             you have done a previous search that TextWare can 
  1127.             compare it against.
  1128. The logical operators and, or and andnot do not have to be in 
  1129. uppercase letters.  They are only shown that way here for clarity.
  1130. Text Retrieval - Displaying Images
  1131. If a Card has been tagged with an image, that image will  
  1132. automatically be displayed in a separate window which appears 
  1133. behind the Card window.  To view the image, click on the Image 
  1134. window.  The Image window will now be displayed in front of the 
  1135. Card.  This window gives you the option of zooming in or out and 
  1136. scrolling through the images associated with each Card.  The first 
  1137. image from the Policies & Procedures manual, with descriptions of 
  1138. the image window, is shown in the image window:
  1139.                      Click on Image Window
  1140. To return to the Card, click on the Card window and the image will 
  1141. now be behind the Card.
  1142. TAG_12.PICT;1
  1143. Text Retrieval - Finding Words Inside Displayed Cards
  1144. When TextWare displays a Card, the query word is displayed in large, 
  1145. bold print and the text is positioned so that the first occurrence of 
  1146. the query word in the Card is displayed as shown in the image 
  1147. window:
  1148.                      Click on Image Window
  1149. Use the scroll bars to move through the Card and find all occurrences 
  1150. of the query word.  If you are using a large-screen monitor you may 
  1151. stretch the window so that the entire Card is displayed.
  1152. TAG_11.PICT;1
  1153. Text Retrieval - Macintosh Clipboard
  1154. TextWare provides full support for the Macintosh Clipboard. To 
  1155. transfer text from a Card to other applications select (highlight) the 
  1156. text you wish to copy and choose Copy from the Edit menu as shown 
  1157. in the image window:
  1158.                      Click on Image Window
  1159. At this point the selected text is in the Clipboard, ready to be pasted 
  1160. into another application.  You may copy the entire Card by choosing 
  1161. Select All (or pressing Command A), then choosing Copy from the 
  1162. Edit menu (or pressing Command C).
  1163. Images may be copied by bringing the Image window to the front and 
  1164. choosing Copy from the Edit menu. At this point the selected image 
  1165. is in the Clipboard, ready to be pasted into another application.
  1166. TAG_16.PICT;1
  1167. Text Retrieval - Navigation Panel
  1168. When a CardFile is accessed, the first Card and any associated 
  1169. images will be displayed.  Also, the Navigation Panel is displayed in 
  1170. the upper right corner of the screen.  This panel is the same as the 
  1171. Navigate menu.  The panel is explained in the image window:
  1172.                      Click on Image Window
  1173. TAG_6.PICT;1
  1174. To hide the Navigation Panel, click on the close box on the panel or 
  1175. select Hide Navigation Panel in the Windows menu as shown in the 
  1176. image window:
  1177.                      Click on Image Window
  1178. To redisplay the Navigation Panel, select Show Navigation Panel on 
  1179. the Windows menu as shown in the image window:
  1180.                      Click on Image Window
  1181. TAG_28.PICT;1
  1182. Text Retrieval - Phrase Searches
  1183. Phrase searching allows you to find words in a specific order in the 
  1184. CardFile.  For example, instead of finding "floating" and "holiday" in 
  1185. the same Card, you may want to find the phrase "floating holiday."
  1186. To perform a phrase search, enter the phrase within quotes (" ") in 
  1187. the search box as shown in the image window:
  1188.                      Click on Image Window
  1189. TAG_31.PICT;1
  1190. Text Retrieval - Printing a Card
  1191. TextWare allows you to print a Card to any Chooser-selectable 
  1192. printer such as the LaserWriter or ImageWriter.  Simply locate the 
  1193. Card you wish to print and select Print on the File menu for the Card 
  1194. data to print as shown in the image window:
  1195.                      Click on Image Window
  1196. You may also press Command P to print the Card.  A screen similar to 
  1197. the following will appear as shown in the image window:
  1198.                      Click on Image Window
  1199. TAG_32.PICT;1
  1200. You may enter the number of copies of the card that you wish and 
  1201. then press return or click on OK to print the Card.  If you decide not 
  1202. to print the Card, click on Cancel to cancel the print operation and 
  1203. return to the program.
  1204. You may also change the font for the Card from the default 9 point to 
  1205. 12 point.  To do this select Use 12 point Font from the Options menu 
  1206. or press Command T as shown in the image window:
  1207.                      Click on Image Window
  1208.   
  1209. To return to the default 9 point font select Use 9 point Font from the 
  1210. Options menu or press Command T as shown below:
  1211.                      Click on Image Window
  1212. You may also change the paper size, orientation and other print 
  1213. options.  Refer to Text Retrieval - Page Setup.
  1214. TAG_15.PICT;1
  1215. Text Retrieval - Printing Images
  1216. TextWare allows you to print an Image to any Chooser-selectable 
  1217. printer such as the LaserWriter or ImageWriter.  Simply locate the 
  1218. Image you wish to print and select Print Image on the File menu to 
  1219. print the image as shown in the image window:
  1220.                      Click on Image Window
  1221. A window similar to the following will then be displayed as shown 
  1222. in the image window:
  1223.                      Click on Image Window
  1224. Press return or click on OK to print the image.  If you decide not to 
  1225. print the image, click on Cancel to cancel the print operation and 
  1226. return to the program.
  1227. TAG_32.PICT;1
  1228. Text Retrieval - Proximity Searches
  1229. Proximity searches allow you to find one or more words within 10 
  1230. words of one another.  For example, instead of finding "paid" and 
  1231. "vacation" in the same Card, you may want to find "paid" and 
  1232. "vacation" only when they occur within 10 words of one another.
  1233. To perform a proximity search, enter the words within brackets ([ ]) 
  1234. in the search box as shown in the image window:
  1235.                      Click on Image Window
  1236. TAG_33.PICT;1
  1237. Text Retrieval - Page Setup
  1238. To change the paper size, orientation or other print options, select 
  1239. Page Setup from the File menu as shown in the image window:
  1240.                      Click on Image Window
  1241. A Page Setup window similar to the following will then be displayed 
  1242. as shown in the image window:
  1243.                      Click on Image Window
  1244. TAG_34.PICT;1
  1245. Text Retrieval - Suppressing Text or Images
  1246. Some users may wish to just display images or just display Cards 
  1247. (text).  You may suppress the Cards or suppress the images.  
  1248. However, the Cards and images may not be suppressed at the same 
  1249. time. 
  1250. To suppress the images, select Suppress Images from the Options 
  1251. menu as shown in the image window:
  1252.                      Click on Image Window
  1253. To suppress the Cards, select Suppress Text from the Options menu 
  1254. as shown in the image window:
  1255.                      Click on Image Window
  1256. To restore the Cards or the images, simply select the option again.
  1257. TAG_13.PICT;1
  1258. Text Retrieval - Wildcards 
  1259. Wildcards are symbols that act as variables in a search word.  They 
  1260. are a convenient way to locate various derivatives of a word or 
  1261. words with uncertain spellings.
  1262. For example, if you wanted to know about every reference to rain in 
  1263. a CardFile, and you searched for the word rain, you would miss the 
  1264. occurrence of words like rained, raining and rains.
  1265. Two wildcards are available:
  1266. *    Matches an unlimited number of characters in that location to 
  1267. complete a word.
  1268. ?    Matches any single character in that location to complete a 
  1269. word.
  1270. Wildcards may not be placed at the beginning of a word. However, 
  1271. either wildcard may be used at the end of or within any word, as in 
  1272. the following examples:
  1273.                 inv*
  1274.                 pol*ies
  1275.                 polic*
  1276.                 ni?e
  1277.                 nin?
  1278. Experiment with these examples in the Policies & Procedures 
  1279. CardFile.
  1280. Creating ambiguous search words using wildcards can lead to 
  1281. overwhelming search results.  You should avoid using ambiguous 
  1282. searches like "a*."  These searches can produce hundreds of Cards, 
  1283. consuming unwarranted time and producing meaningless results.
  1284.